Defensics Jenkins Plugin

This plugin allows Jenkins builds to run Defensics as a build or post-build step. This README includes information for plugin developers. For information on how to use the plugin, see Defensics Jenkins Plugin User Guide.

Getting started

Prerequisites

• Java 11
• Maven

Configuring IntelliJ IDEA

We use IntelliJ IDEA (community edition is enough) for development. Any IDE will do, but these instructions are only for IDEA.

Running and debugging the plugin

In IntelliJ IDEA

1. Go to Run > Edit configurations > + > Maven.
2. Give a name to this configuration, e.g. "Run Defensics Jenkins Plugin".
3. Add hpi:run to Command line.

Now you can run or debug your project from IDEA. Starting up can take a minute or two the first time, because IDEA downloads things like the Jenkins .war. You can find Jenkins by browsing to http://localhost:8080/jenkins.

When you make changes to the plugin, click Run > Reload Changed Classes to see the changes in Jenkins. For some changes this may not be enough, and you will have to stop and re-run the project.

Running and debugging tests

You can run individual tests or tests for a package in IDEA by right-clicking and selecting Run. But to run the complete test suite, including tests injected by Jenkins, follow these steps:

In IntelliJ IDEA

1. Go to Run > Edit configurations > + > Maven.
2. Give a name to this configuration, e.g. "Test Defensics Jenkins Plugin".
3. Add the word verify to Command line. ("test" runs unit tests, "verify" runs both unit and integration tests.)

Now you can run or debug the whole test suite for this project from IDEA. It's important to do either this, or run "mvn verify" from command line before pushing, to make sure the build will not break.

Coding conventions

This project follows the Google Coding Conventions for Java.

Run from command line

To run both Jenkins and the plugin in it:

mvn hpi:run

Jenkins will be downloaded and installed on first run. You can find Jenkins by browsing to http://localhost:8080/jenkins.

Manual Installation

To build the hpi file:

mvn clean verify

This will compile, test and package the plugin into a Jenkins plugin installation package in target/defensics-plugin.hpi.

To install the plugin manually to a Jenkins:

1. Upload and install Defensics Plugin defensics-plugin.hpi from Manage Jenkins -> Plugins -> Advanced.
2. Restart Jenkins.

Release notes

Version 2023.9.0

• Download report and optionally result-package also in the following cases:
  1. run was terminated with ERROR/FATAL state, 2) run was interrupted. Previously report and result-package were downloaded only when all planned test cases were run.
• Plugin dependencies and core libraries are updated. Now the oldest supported Jenkins version is 2.375.4 which requires Java 11.
• The used HTTP client was changed from OkHttp to Java 11 HTTP client to fix the CVE-2023-3635 vulnerability and to reduce dependencies.
• This plugin version requires Defensics 2023.6.0 or newer.

Version 2022.12.0

• Update plugin to match Defensics 2022.12 API changes. This plugin version requires Defensics 2022.12.0 or newer.
• Plugin dependencies and core libraries are updated. Now the oldest supported Jenkins version is 2.319.3.

Version 2021.9.0

• Plugin version scheme is unified to follow Defensics versioning
• Plugin dependencies and core libraries are updated to fix security issues. Now the oldest supported Jenkins version is 2.263.1.

Version 1.2.1

• Update plugin to match Defensics 2021.06 API changes
• Use testplan name in the result package links to find correct result more easily
• Print suite and server version during build
• Various bug fixes: report download on long runs, better error handling on suite load errors, stop build on fuzz job interrupt, etc. See CHANGELOG for more details.

Version 1.2.0

• Update plugin to work with Defensics 2021.03 API changes so this version requires Defensics 2021.03 or newer

Version 1.1.0

• Change plugin to use new server API so this version requires Defensics 2020.12 or newer
• Fix report download issue when using remote Jenkins nodes

Version 1.0.3

• Fix abort handling for pipeline jobs
• Fix internal links within User Guide
• Fix "null not assignable to interface hudson.model.Action" warning after successful pipeline run.

Version 1.0.2

• Show more information for runs in error state
• Improve run stopping in pipeline jobs
• Fix internal links within User Guide

Version 1.0.1

• Fix links to User Guide

Version 1.0.0

• Initial release